home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d6 / kgraf.arc / KGTUTOR.KG < prev    next >
Text File  |  1989-04-01  |  11KB  |  277 lines
  1. @DISPLAY BORDER
  2.                                KWIKGRAF TUTORIAL
  3.                                -----------------
  4.                        (C)Copyright Alan C. Elliott, 1989
  5.  
  6. CONTENTS:        1. KWIKGRAF COMMANDS
  7.  
  8.                  2. RUNNING KWIKGRAF FROM DOS
  9.  
  10.                  3. RUNNING KWIKGRAF FROM dBASE III
  11.  
  12.                  4. USING A KWIKGRAF COMMAND FILE
  13.                     - From DOS
  14.                     - From the KWIKGRAF menu
  15.  
  16.                  5. USING KWIKGRAF FROM THE MENU
  17.  
  18. The Shareware concept is "try it before you buy it".  If you use this 
  19. program, please become a registered user by sending in the order blank that 
  20. you will find in the documentation. By registering, you will receive the 
  21. latest version of KWIKGRAF, a printed and bound manual, and you will be 
  22. placed on the KWIK-BITS newsletter mailing list.  Register today! 
  23. @END
  24. @DISPLAY BORDER
  25.  
  26.  
  27. The KWIKGRAF command line specifics what database to use, which graph to 
  28. draw, which variable in the database to use, a title, and other information 
  29. specific to the graph being displayed.  A command line looks like this: 
  30.  
  31. DATA=EXAMPLE GRAPH=PIE X=STATUS TITLE="THIS IS MY TITLE"
  32.  
  33. Important points:
  34.  
  35.     1. No blanks between the key word (i.e. DATA), the equal sign and
  36.        the specification (i.e. EXAMPLE)
  37.     2. Case does not matter.
  38.     3. Titles MUST be enclosed in quotes
  39.  
  40. In this example, the database is specified by the DATA keyword, and the 
  41. database name is EXAMPLE.  The GRAPH keyword specifies a PIE chart.  The X 
  42. variable is has the field name STATUS, and the TITLE is "THIS IS MY TITLE". 
  43.  
  44. @END
  45. @DISPLAY BORDER
  46.  
  47. Required KWIKGRAF keywords for drawing a graph:
  48.  
  49.     DATA=          Specified datebase name
  50.  
  51.     GRAPH=         Specifies graph type. This can be PIE
  52.                    HISTOGRAM, PICTOGRAPH, SCATTERPLOT,
  53.                    TIMEPLOT or 3-D HISTOGRAM.  These can be
  54.                    abbreviated to PIE, HISTO, PICTO, SCAT,
  55.                    TIME and 3-D.
  56.  
  57.     X=             Specifies field name of variable to use
  58.  
  59. If two variables are required, as in SCAT and 3-D, then a required
  60. keyword is:
  61.  
  62.     Y=             Specifies second field name
  63.  
  64. @END
  65. @DISPLAY BORDER
  66.  
  67.                              PIE CHART SUMMARY
  68.                                 -----------
  69.  
  70.  
  71. Required Keywords: DATA=databasename
  72.                    GRAPH=PIE
  73.                    X=fieldname
  74.  
  75.  
  76. Optional Keywords: TITLE="enclose title in quotes"
  77.  
  78.  
  79. For example, the command from DOS
  80.  
  81. KWIKGRAF DATA=EXAMPLE GRAPH=PIE X=STATUS TITLE="Pie Chart on Status"
  82.  
  83.  
  84. Will produce the following graph:
  85.  
  86. @END
  87. DATA=EXAMPLE GRAPH=PIE X=STATUS+
  88. TITLE="Status from Example Database"
  89. @DISPLAY BORDER                                     
  90.                                                     
  91.                                                     
  92.                                PICTOGRAM SUMMARY
  93.                                    ----------
  94.                                                     
  95. Required Keywords: DATA=databasename                
  96.                    GRAPH=PICTO
  97.                    X=fieldname
  98.                    IMG=imagefile
  99.  
  100. Optional Keywords: TITLE="enclose title in quotes"
  101.  
  102. Several image files are included on disk, including BAR1.IMG, which is a 
  103. small bar, and BAR2.IMG, which is a large bar.  Images are created in the
  104. utility module.
  105.  
  106. For example, the command from DOS
  107.                                                     
  108. KWIKGRAF DATA=EXAMPLE GRAPH=PICTO X=STATUS IMG=PERSON TITLE="Status"
  109.  
  110. Will produce the following graph:                                      
  111. @END
  112. DATA=EXAMPLE GRAPH=PICTO X=STATUS IMG=PERSON TITLE="Status"
  113. @DISPLAY BORDER
  114.  
  115.                                HISTOGRAM SUMMARY
  116.                                    ----------
  117.  
  118. Required Keywords: DATA=databasename
  119.                    GRAPH=HISTO
  120.                    X=fieldname (must be numeric)
  121.                                                     
  122.                                                     
  123. Optional Keywords: TITLE="enclose title in quotes"  
  124.                                                     
  125.                                                     
  126. For example, the command from DOS
  127.  
  128. KWIKGRAF DATA=EXAMPLE GRAPH=HISTO X=AGE TITLE="Histogram on Age"
  129.  
  130. will produce the following graph:
  131.  
  132.  
  133. @END
  134. DATA=EXAMPLE GRAPH=HISTO X=AGE TITLE="Histogram on Age"
  135. @DISPLAY BORDER                                         
  136.  
  137.                              3-D BAR CHART SUMMARY
  138.                                    ----------           
  139.                                                         
  140. Required Keywords: DATA=databasename                    
  141.                    GRAPH=3-D
  142.                    X=fieldname
  143.                    Y=fieldname
  144.  
  145. Optional Keywords: TITLE="enclose title in quotes"      
  146.                                                         
  147.                                                         
  148. For example, the command from DOS
  149.                                                         
  150. KWIKGRAF DATA=EXAMPLE GRAPH=3-D X=STATUS Y=GROUP TITLE="Status By Group"
  151.                                                         
  152. will produce the following graph:                       
  153.                                                         
  154.                                                         
  155. @END                                                    
  156. DATA=EXAMPLE GRAPH=3-D X=STATUS Y=GROUP TITLE="Status By Group"
  157. @DISPLAY BORDER                                                           
  158.                                                                           
  159.                               SCATTERPLOT SUMMARY
  160.                                    ----------                             
  161.                                                                           
  162. Required Keywords: DATA=databasename                                      
  163.                    GRAPH=SCAT
  164.                    X=fieldname (must be numeric)
  165.                    Y=fieldname (must be numeric)
  166.                                                                           
  167. Optional Keywords: TITLE="enclose title in quotes"
  168.                                                                           
  169.                                                                           
  170. For example, the command from DOS                                         
  171.                                                                           
  172. KWIKGRAF DATA=EXAMPLE GRAPH=SCAT X=TIME1 Y=TIME2 TITLE="Time1 by Time2"
  173.                                                                           
  174. will produce the following graph:                                         
  175.                                                                           
  176.                                                                           
  177. @END                                                                      
  178. KWIKGRAF DATA=EXAMPLE GRAPH=SCAT X=TIME1 Y=TIME2 TITLE="Time1 by Time2"  
  179. @DISPLAY BORDER                                                          
  180.                                                                          
  181.                             TIME SERIES PLOT SUMMARY
  182.                                    ----------                            
  183.                                                                          
  184. Required Keywords: DATA=databasename                                     
  185.                    GRAPH=TIME
  186.                    X=fieldname (must be numeric)                         
  187.  
  188. Optional Keywords: TITLE="enclose title in quotes"                       
  189.                                                                          
  190.                                                                          
  191. For example, the command from DOS                                        
  192.                                                                          
  193. KWIKGRAF DATA=EXAMPLE GRAPH=TIME X=TIME1 TITLE="Plot of Time1"
  194.                                                                          
  195. will produce the following graph:                                        
  196.  
  197. @END                                                                     
  198. KWIKGRAF DATA=EXAMPLE GRAPH=TIME X=TIME1 TITLE="Plot of Time1"
  199. @DISPLAY BORDER
  200.  
  201.                         RUNNING KWIKGRAF from dBASE III
  202.                                    ----------
  203.  
  204.  
  205. From within dBASE III, either from command mode, or in a program, you can 
  206. cause a KWIKGRAPH graph to be produced by using the RUN command.  For
  207. example, to produce the last TIME SERIES PLOT, you would have used the 
  208. command: 
  209.  
  210. .RUN KWIKGRAF DATA=EXAMPLE GRAPH=TIME X=TIME1 TITLE="Plot of Time1"
  211.  
  212. For this to work, the KWIKGRAF program needs to be in the same subdirectory 
  213. as dBASE III.  Otherwise, you need to place the path name before the 
  214. KWIKGRAF command. 
  215.  
  216. @END
  217. @DISPLAY BORDER
  218.                         USING KWIKGRAF COMMAND FILES
  219.                                  ----------
  220.  
  221. This tutorial was written using a KWIKGRAF command file.  This file 
  222. contains a series of KWIKGRAF commands, all following the same syntax as 
  223. if you had given the command from DOS. Here are some examples:
  224.  
  225. KWIKGRAF DATA=EXAMPLE GRAPH=SCAT X=TIME1 Y=TIME2 TITLE="Time1 by Time2"
  226. KWIKGRAF DATA=EXAMPLE GRAPH=3-D X=STATUS Y=GROUP TITLE="Status By Group"
  227.  
  228. If your command is too long for a line, your can place a "+" at the end 
  229. of the line, which will make KWIKGRAF continue to read it to the next 
  230. line.  For example:
  231.  
  232. KWIKGRAF DATA=EXAMPLE GRAPH=SCAT X=TIME1 Y=TIME2 +
  233. TITLE="Time1 by Time2"
  234.  
  235. continued . . .
  236. @END
  237. @DISPLAY BORDER
  238.  
  239.                      USING KWIKGRAF COMMAND FILES continued
  240.                                  ----------
  241.  
  242. To cause text, such as what you are reading to be displayed, place the 
  243. command @DISPLAY on a line, followed by all of the lines to display, and 
  244. end the display with the command @END.  If you place the keyword BORDER
  245. on the line with @DISPLAY, a border will appear around the text. To run a 
  246. command file, enter the following command from DOS.
  247.  
  248. KWIKGRAF FILE=commandfile
  249.  
  250.  
  251. Command files should have a .KG extension.
  252.  
  253. You may also run a command file from the KWIKGRAF menu. Simply select the     
  254. menu option "Run a KWIKGRAF command file," and you will be prompted to enter  
  255. the name of the command file to run. Speaking of menu mode ...
  256.  
  257. @END
  258. @DISPLAY BORDER
  259.  
  260.                                The KWIKGRAF Menu
  261.                                    ----------
  262.  
  263. If you enter the KWIKGRAF command from DOS with no other keywords, you will 
  264. be in "menu" mode, where you can interactively create graphs.
  265.  
  266. There are a few more options you can choose from the menu mode than from the 
  267. command mode, such as specifying certain minimums and maximums for graphs.
  268. You can also run two other KWIKGRAF programs, KWIKDATA and KWIKUTIL
  269.  
  270. KWIKDATA - create a DATABASE file, enter data, manipulate data.
  271.  
  272. KWIKUTIL - Create an IMAGE, set colors and default disk, output reports.
  273.  
  274. @END
  275. TABASE file, enter data, manipulate data.
  276.  
  277. KWIKUTIL - Cre